Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

shim Apple's futex primitives #4142

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Conversation

joboet
Copy link
Member

@joboet joboet commented Jan 19, 2025

This is necessary to unblock rust-lang/rust#122408. The documentation for these is available here.

Because the futex wait operations (os_sync_wait_on_address et al.) return the number of remaining waiters after returning, this required some changes to the common futex infrastructure, which I've changed to take a callback instead of precalculating the return values.

@RalfJung
Copy link
Member

Thanks for the PR! I just left for a 1-week business trip and will have to catch up with stuff when I am back so it could take a bit before I can take a closer look.

@rustbot

This comment has been minimized.

@rustbot rustbot added the S-waiting-on-author Status: Waiting for the PR author to address review comments label Jan 29, 2025
Copy link
Member

@RalfJung RalfJung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot! Overall approach looks great, but I have a bunch of questions and comments. :)

src/concurrency/sync.rs Outdated Show resolved Hide resolved
src/shims/unix/linux_like/sync.rs Outdated Show resolved Hide resolved
src/shims/windows/sync.rs Outdated Show resolved Hide resolved
src/shims/windows/sync.rs Outdated Show resolved Hide resolved
src/shims/unix/macos/foreign_items.rs Show resolved Hide resolved
fn wake_nobody() {
let futex = 0;

// Wake 1 waiter. Expect zero waiters woken up, as nobody is waiting.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Wake 1 waiter. Expect zero waiters woken up, as nobody is waiting.
// Wake 1 waiter. Expect ENOENT, as nobody is waiting.

tests/pass-dep/concurrency/apple-futex.rs Show resolved Hide resolved
tests/pass-dep/concurrency/apple-futex.rs Outdated Show resolved Hide resolved
tests/pass-dep/concurrency/apple-futex.rs Show resolved Hide resolved
size_of::<i32>(),
libc::OS_SYNC_WAIT_ON_ADDRESS_NONE,
),
0,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a test where wait_on_address returns something non-zero (since there are more waiters).

Copy link
Member Author

@joboet joboet Feb 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While doing this, I noticed that the reported count was incorrect if os_sync_wake_by_address_all was used as the threads were woken one-by-one. dfa8d2fa13d2c9972208ab7dbc62e197a44f1920 fixes this (and also gets rid of the quadratic runtime of wakeup 😄).

This is necessary to unblock rust-lang/rust#122408. The documentation for these is available [here](https://developer.apple.com/documentation/os/os_sync_wait_on_address?language=objc).

Because the futex wait operations (`os_sync_wait_on_address` et al.) return the number of remaining waiters after returning, this required some changes to the common futex infrastructure, which I've changed to take a callback instead of precalculating the return values.
On macOS, the futex operations return the number of outstanding waiters. For this count to be correct, we have to remove all eligible threads from the internal futex list before any of the wakeup callbacks are run. This has the nice side-effect of making the runtime removal operation linear in the number of threads instead of quadratic.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-author Status: Waiting for the PR author to address review comments
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants